home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / adult_ed / reccon20 / rec_conv.txt < prev   
Text File  |  1995-05-02  |  20KB  |  617 lines
  1.            Mountain Software Presents:           
  2.  
  3.  
  4.               The Recipe Converter
  5.  
  6.                        by
  7.  
  8.                  Anthony Watson
  9.  
  10.  
  11. 1.0 - Introduction
  12.      
  13.      1.1 - Purpose For The Converter
  14.      1.2 - System Requirements
  15.      1.3 - Supported Formats
  16.      1.4 - Limitations
  17.  
  18. 2.0 - Main Menu
  19.  
  20.      2.1 - Version Number/Release Date
  21.      2.2 - How To Reach The Author
  22.      2.3 - Converting A Recipe
  23.      2.4 - Manual Conversions
  24.      2.5 - QUIT
  25.  
  26. 3.0 - Configuring The User Interface
  27.  
  28.      3.1 - Changing Color Settings
  29.      3.2 - Changing Button Settings
  30.      3.3 - Setting Secondary Text
  31.      3.4 - Setting Back Fill
  32.      3.5 - Saving Configuration Settings
  33.      3.6 - Loading Configuration Settings
  34.  
  35. 4.0 - Final Comments
  36.  
  37.      4.1 - Author Assistance
  38.      4.2 - Revision History
  39.      4.3 - Appreciation
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46. -------------------------------------------------
  47. 1.0 - INTRODUCTION
  48. -------------------------------------------------
  49.  
  50.  
  51. 1.1 - Purpose For The Converter
  52. -------------------------------------------------
  53.  
  54.   There are many recipe formats in existance for 
  55. many computer platforms. Unfortunatly, each 
  56. format is incompatible with any other format, 
  57. and thus it has not been possible to load 
  58. recipes from one recipe program into another; 
  59. especially between various computer platforms. 
  60. Popular formats include Meal-Master and Q-Book 
  61. (IBM formats), Assistant Chef and Recipe Box 
  62. (Atari ST formats), and a host of other not so 
  63. popular formats. (Computer Chef, etc.). In 
  64. addition, many times recipes are not stored in 
  65. any particular format at all, having just been 
  66. entered using a Word Processor or Text Editor. 
  67. The Recipe Converter attempts to give you an 
  68. easier method to format recipes into the format 
  69. required by The Recipe Box, without having to 
  70. retype them all.
  71.  
  72.  
  73. 1.2 - System Requirements
  74. -------------------------------------------------
  75.  
  76. The Recipe Converter should work on any 
  77. ST/STE/TT/Falcon in any graphics mode greater 
  78. than 640 x 200 resolution.
  79. (ST medium, ST high, TT medium, TT high, etc.)
  80.  
  81. The Recipe Converter requires 500K of free RAM. 
  82. You should disable all accessories and auto 
  83. folder programs if you are short on memory.
  84.  
  85. The Recipe Converter will run from a floppy 
  86. disk but a hard drive is highly recommended!
  87.  
  88.  
  89.  
  90.  
  91. 1.3 - Supported Formats
  92. -------------------------------------------------
  93.  
  94.   The Recipe Converter will automatically 
  95. convert from a number of recipe formats to The 
  96. Recipe Box format. These formats include:
  97.  
  98.         - The Recipe Box Chapters
  99.         - The Recipe Box Recipes
  100.         - Assistant Chef Data files
  101.         - Meal-Master
  102.         - Computer Chef
  103.  
  104.   In addition, using the Manual marking feature 
  105. of The Recipe Converter, you can also convert 
  106. many other 'unsupported' formats, such as 
  107. QuikBook, or any ASCII file.
  108.  
  109.   The files output from The Converter will 
  110. contain 22 recipes in each file, or less. The 
  111. files will derive their name from the source 
  112. file and end with a numerical extension.
  113.  
  114.   For example, if you had an input file named 
  115. DESS.CCF with 30 recipes in it. You would get 
  116. two output files named DESS.1 (with 22 recipes) 
  117. and DESS.2 (with 8 recipes).
  118.  
  119.  
  120. 1.4 - Limitations
  121. -------------------------------------------------
  122.  
  123.   The Recipe Converter is designed to convert 
  124. recipes in one direction only. In other words, 
  125. you could convert from Computer Chef to The 
  126. Recipe Box, but not from The Recipe Box to 
  127. Computer Chef. If there is enough demand for two 
  128. way conversions, I may consider implementing it 
  129. in a future version.
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.   When manually converting recipes, The 
  137. Converter will only load 5000 lines of text. If 
  138. this is insufficient, you could load the file 
  139. into a text editor, and save sections back out 
  140. as smaller files. The automatic conversion 
  141. routines have no limit as to the input file size.
  142.  
  143.   The unregistered version of The Recipe 
  144. Converter will only convert the first 22 recipes 
  145. of a recipe file. This is equivalent to one 
  146. chapter in The Recipe Box version 3.5. 
  147.  
  148.   While The Recipe Converter does a respectable 
  149. job on most files, it is unavoidable that a file 
  150. or two will cause problems for The Converter. 
  151. Often, these files can be handled with the 
  152. Manual Marking methods. But occasionally the 
  153. only option is to retype the recipe into The 
  154. Recipe Box.
  155.  
  156.   The success of conversions varies depending on 
  157. the file type, and how strictly the file adheres 
  158. to the format definitions of that file type. 
  159. Often recipe format files are mistaken for 
  160. common ASCII text files and are modified 
  161. unknowingly. Most often these types of files are 
  162. obtained over BBS networks, or similar 
  163. situations.
  164.  
  165.   It is highly recommended that you verify the 
  166. validity of the converted file before deleting 
  167. the source file. Because of reasons mentioned 
  168. above, the conversion may not always be 
  169. successful. While it is unlikely this program 
  170. could do any harm to your files or system, 
  171. Mountain Software claims no responsibility for 
  172. damages occuring from it's use.
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181. -------------------------------------------------
  182. 2.0 - MAIN MENU
  183. -------------------------------------------------
  184.  
  185.   The main menu is the screen that is first 
  186. presented when you run The Recipe Converter. 
  187. This is where most operations take place, and 
  188. where most information is displayed.
  189.  
  190.  
  191. 2.1 - Version Number/Release Date
  192. -------------------------------------------------
  193.  
  194.    On the main menu you will find a button with 
  195. the current version number, and the date this 
  196. version was released.
  197.  
  198.    If you click on this button you will be 
  199. presented with the registration fees and where 
  200. you may send for registration.
  201.  
  202.    Once you have registered this program, this 
  203. button will show the current registered owner.
  204.  
  205. 2.2 - How To Reach The Author
  206. -------------------------------------------------
  207.   If you have a question, comment, or complaint 
  208. about this program you are encouraged to contact 
  209. the author, Anthony Watson.
  210.  
  211.   On the main menu of The Converter, you will 
  212. see a short step by step tutorial. By clicking 
  213. on this display, you will be presented with the 
  214. authors address, and various BBS's and online 
  215. services where I may be contacted.
  216.  
  217.   If you are experiencing a problem, I would 
  218. suggest that you first read the documentation. 
  219. I've found that most problems stem from not 
  220. understanding how the program works, and not 
  221. from a bug in the program. But if you've read 
  222. the documentation, and you still cannot get 
  223. something to work right, please feel free to 
  224. contact me!
  225.  
  226. 2.3 - Converting A Recipe
  227. -------------------------------------------------
  228.  
  229.   As stated previously, some recipe formats are 
  230. converted automatically, while others require 
  231. manual marking of various recipe segments.
  232.  
  233.   The easiest approach is to click on the 
  234. 'CONVERT' button first, locate the input file 
  235. and specify the output path. The file will be 
  236. examined to see if it matches any of the known 
  237. formats.
  238.  
  239.   If the file matches an established format, the 
  240. conversion will proceed without further 
  241. assistance.
  242.  
  243.   If the file does not match an established 
  244. format, a message will be displayed suggesting 
  245. that you try the manual conversion method.
  246.  
  247.   Some files, even those which match known 
  248. formats, do not convert properly. For these 
  249. files, you can select 'MANUAL' to make a manual 
  250. attempt at the conversion.
  251.  
  252.   The file type is determined by checking the 
  253. first text line only. Occasionally BBS 
  254. information or similar is 'tacked on' to the 
  255. beginning of a recipe file, and even though the 
  256. recipe file may be properly formatted, it will 
  257. fail to be recognized as an established format.
  258.  
  259.   Therefore, you may wish to edit out the extra 
  260. lines using a text editor before attempting the 
  261. conversion. The first line of the recipe file 
  262. must contain one of the following strings to be 
  263. recognized as an established format:
  264.  
  265.   'The Recipe Box Chapter' - Recipe Box Chapters
  266.   'The Recipe Box Recipe'  - Recipe Box Recipes
  267.   'Meal-Master'            - Meal Master Exports
  268.   Only '*'s or spaces      - Computer Chef
  269.  
  270.  
  271.   Assistant Chef is a special case and does not 
  272. follow these guidelines! Assistant Chef uses 
  273. three files to store recipes INDEX.DAT, 
  274. INGREDS.DAT, and DIRECTNS.DAT. All three files 
  275. must be in one directory for conversion to 
  276. succeed.
  277.  
  278.  
  279. 2.4 - Manual Conversions
  280. -------------------------------------------------
  281.   The manual conversion menu allows you to 
  282. convert files which do not match established 
  283. formats, or which did not successfully convert 
  284. using automatic methods.
  285.  
  286.   To obtain the manual conversion menu, click on 
  287. the 'MANUAL' button from the main menu. You will 
  288. be asked to locate the file you wish to convert. 
  289. Next you must specify an output path for the 
  290. converted files.
  291.  
  292.   Once the manual menu appears, you will see a 
  293. series of buttons across the top of the screen, 
  294. the text of the file you selected, and a 
  295. 'highlight' line indicating the currently 
  296. selected line.
  297.  
  298.   All operations in the Manual Conversion menu 
  299. are carried out using the mouse. This allows 
  300. simple one handed operation, and eases a tedious 
  301. process.
  302.  
  303.   When the mouse is over the recipe text, the 
  304. mouse keys are used to 'scan' the highlight line 
  305. up or down through the text file. Pressing the 
  306. left mouse key to scan up, and the right mouse 
  307. key to scan down.
  308.  
  309.   A recipe has six recipe segments, regardless 
  310. of format. The buttons at the top of the screen 
  311. reflect these segments. You mark the segment by 
  312. placing the highlight line over the line of the 
  313. text which defines that part of the recipe. Then 
  314. you click on the corresponding button.
  315.  
  316.   When you click on one of the segment buttons, 
  317. it will stay depressed indicating which segments 
  318. you have marked, and which ones remain. Even if 
  319. a segment has been marked, you can change that 
  320. setting by locating the new mark, and clicking 
  321. the button again.
  322.  
  323.   You cannot save a recipe until all six 
  324. segments have been marked! The segments and 
  325. buttons are defined as follows:
  326.  
  327.   * Title - This is the name or 'title' of the 
  328.     recipe.
  329.  
  330.   * Servings - This is the number of servings 
  331.     that the recipe makes. If the recipe does not
  332.     specify a servings amount, mark a blank line
  333.     or any line which does not contain a servings
  334.     specification.
  335.    
  336.     To be recognized as a valid servings line the
  337.     word 'SERVINGS' must appear somewhere on the
  338.     line that was marked. For example,
  339.     4 servings, or Servings: 4 would both be 
  340.     valid serving definitions, whereas Serves 4 
  341.     would not be!
  342.  
  343.   * Ing. Start - This is the start of the 
  344.     ingredients portion of the recipe. The 
  345.     ingredients are the portion of a recipe 
  346.     which define what items go into a recipe 
  347.     and in what quantities.
  348.  
  349.   * Ing. End - This is where the recipe 
  350.     ingredients end. Please note that you cannot
  351.     specify the ingredients end before the start!
  352.  
  353.   * Dir. Start - This is the start of the 
  354.     directions. The directions are the portion of
  355.     a recipe which define the steps and methods 
  356.     required to produce the final product.
  357.  
  358.   * Dir. End - This is the end of the directions.
  359.     Please note that you cannot specify the 
  360.     directions end before the start!
  361.  
  362. NOTE:  You 'CAN' overlap your selections for 
  363. ingredients and directions. There is an 
  364. intentional reason for this. Certain recipes, 
  365. have a few ingredients, then a few directions, 
  366. then a few ingredients, etc. This wreaks havoc on 
  367. the selection process! So to allow you to still 
  368. be able to properly convert these recipes, you 
  369. can select where the first ingredient is and then 
  370. where the last ingredient is. Then repeat the 
  371. procedure with the directions. You'll end up with 
  372. certain portions of the recipe duplicated in the 
  373. ingredients AND directions. Once you import the 
  374. file into The Recipe Box, you can go back and 
  375. delete the offending lines from each portion. Not 
  376. simple, but do-able!
  377.  
  378.   Also if your recipe contains 2 recipes. (i.e. A 
  379. cake and it's frosting) Simply mark them as two 
  380. 'seperate' recipes.
  381.  
  382.   * Load New File - This button allows you to 
  383.     load in another recipe file. This can be used
  384.     to 'pick and choose' recipes from multiple 
  385.     files, or to merge many small files into 
  386.     larger files.
  387.  
  388.   * Save Recipe - Once you have marked all six 
  389.     recipe segments, You save the recipe to the 
  390.     output file by clicking on this button. This 
  391.     button will not function if you have not 
  392.     marked all segments! After the recipe has
  393.     been saved, the settings are all cleared, and
  394.     you can then repeat the marking procedure
  395.     for as many recipes as you wish to convert.
  396.  
  397.     Also, a recipe title must be 40 characters or
  398.     less. If the title exceeds this, you will be 
  399.     asked to enter a new title. If you abort this 
  400.     without entering a new title, the left 40 
  401.     characters of the title line will be used as 
  402.     the title.
  403.  
  404.  
  405.  
  406.   * Clear - If for some reason you have set 
  407.     several recipe segments and wish to start 
  408.     over, this button will clear all current
  409.     settings.
  410.  
  411.   * QUIT - This button saves out the final file, 
  412.     and returns you to the main menu.
  413.  
  414.  
  415. 2.5 - QUIT
  416. -------------------------------------------------
  417.  
  418.   When you have finished converting your recipes 
  419. clicking on the 'QUIT' button will return you to 
  420. the desktop, or shell that launched the program.
  421.  
  422.  
  423. -------------------------------------------------
  424. 3.0 - CONFIGURING THE USER INTERFACE
  425. -------------------------------------------------
  426.  
  427.   Often you like the way a program operates, but 
  428. you don't particularly care for the way the 
  429. program looks. This program attempts to overcome 
  430. this problem by allowing the user to configure 
  431. almost all aspects of the user interface to 
  432. his/her own preferences. Select the 
  433. Configuration Menu by clicking on the 
  434. 'CONFIGURE' button on the main menu.
  435.  
  436.   NOTE: If you should get things too messed up 
  437. while configuring the various settings, pressing 
  438. 'UNDO' on the keyboard will reinstall the 
  439. program defaults!
  440.  
  441.  
  442. 3.1 - Changing Color Settings
  443. -------------------------------------------------
  444.  
  445.   This program uses a maximum of four colors 
  446. even if your current graphics mode supports more 
  447. colors than this. 
  448.  
  449.  
  450.  
  451.   On the configuration menu, you will find 4 
  452. buttons displaying the colors that are used. To 
  453. change a color, click on the button 
  454. corresponding to the color you wish to change. 
  455. Then use the red, green and blue 'sliders' to 
  456. change the color settings.
  457.  
  458.   NOTE: In monochrome, colors 2 and 3 will have 
  459. no effect as monochrome is limited to 2 colors. 
  460. The only color change you can make is an 
  461. inversion, by setting color 1 to all zero's or 
  462. all 100's.
  463.  
  464.  
  465. 3.2 - Changing Button Settings
  466. -------------------------------------------------
  467.  
  468.   The button settings allow you to select which 
  469. of your defined colors you wish to use for the 
  470. buttons, highlights, shadows, etc. You can also 
  471. select various texture patterns to simulate 
  472. additional colors, or to provide variety.
  473.  
  474.   Clicking on one of the button settings will 
  475. take you to the next style or color. The color 
  476. selections cycle through the four available 
  477. colors. The style settings cycle though five 
  478. different texture patterns of various density.
  479.  
  480.  
  481. 3.3 - Setting Secondary Text
  482. -------------------------------------------------
  483.  
  484.   This program uses two different text values in 
  485. it's displays. One is for the button titles, and 
  486. the other is used for other additional text. The 
  487. secondary text settings do not affect the button 
  488. text settings, but are set in the same manner as 
  489. the button text settings.
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496. 3.4 - Setting Back Fill
  497. -------------------------------------------------
  498.  
  499.   An optional 'back fill' pattern can be placed 
  500. behind the main screen on certain menu's. The 
  501. Back Fill settings select the color and style of 
  502. this fill. You can disable the back fill by 
  503. setting it to the same color as the screen 
  504. border color.
  505.  
  506. 3.5 - Saving Configuration Settings
  507. -------------------------------------------------
  508.  
  509.   Once you have created a configuration you may 
  510. save it to disk for later use. If you save the 
  511. settings under the default filenames in the same 
  512. directory as this program, your settings will be 
  513. loaded automatically when the program is run. 
  514. The program uses two defaults depending on 
  515. whether the program is run in color or 
  516. monochrome:
  517.  
  518.   COLOR.CFG - The Color Configuration Setup
  519.   MONO .CFG - The Monochrome Configuration Setup
  520.  
  521.   If neither of these files appear in the same 
  522. directory as this program, the program will use 
  523. internal default settings when it is run.
  524.  
  525.   You may save your settings under any name and 
  526. in any directory however, though you will have 
  527. to load them in manually to make use of them.
  528.  
  529.  
  530. 3.6 - Loading Configuration Settings
  531. -------------------------------------------------
  532.  
  533.   This button allows you to locate and load 
  534. previously saved configurations.
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541. -------------------------------------------------
  542. 4.0 - Final Comments
  543. -------------------------------------------------
  544.  
  545.  
  546. 4.1 - Author Assistance
  547. -------------------------------------------------
  548.  
  549. If you have a question about any of the Mountain 
  550. Software programs please feel free to contact 
  551. me. I can't promise to always have the answer 
  552. but I'll do my best to find an answer for you!
  553.  
  554.             Mountain Software
  555.             6911 NE Livingston Road
  556.             Camas, Washington  98607
  557.  
  558.             GEnie: A.WATSON6
  559.            Delphi: MOUNTAINSOFT
  560.              Fnet: #648 - Anthony Watson
  561.         Atari Net: 51:3/9 - Anthony Watson
  562.          Fido Net: 1:105/139 - Anthony Watson
  563.  
  564.  
  565. 4.2 - Revision History
  566. -------------------------------------------------
  567.                   Version  1.2
  568.            Released November 20, 1992
  569.  
  570.  All Mountain Software programs have been updated 
  571. with a new registration routine. This does away 
  572. with the need for a 'key' file, and shortens the 
  573. program file itself. The program now comes 
  574. personalized in your name when you register.
  575.  
  576. NOTE: If you have registered an earlier version 
  577.       you will need to send $5 for the new 
  578.       version and a new manual. I regret having 
  579.       to charge for this upgrade, but I just do
  580.       not have the finances to send all 
  581.       registered users a new disk/manual. My 
  582.       apologies! The new version includes a 
  583.       utility that will allow you to upgrade as 
  584.       new versions become available!
  585.  
  586.                    Version 2.0
  587.              Released February 5, 1993
  588.  
  589. * Implemented a new user configurable interface.
  590.  
  591. * Fixed a few minor bugs with some file types.
  592.  
  593. * Rewrote Owners Manual
  594.  
  595. * Sped up most of the conversion routines
  596.  
  597.  
  598. 4.3 - Appreciation
  599. -------------------------------------------------
  600.  
  601.   I would like to thank those of you who have 
  602. registered previous versions of this program. 
  603. This is admittedly a specialized program, and I 
  604. am pleased you found a use for it! Thank you for 
  605. your support!
  606.  
  607.   I would like to thank Victor Bruhn and Don 
  608. Schmidt for their assistance with this program!
  609.  
  610.   Finally, I would like to thank my wife Peggy 
  611. for her support and patience. Your advice and 
  612. opinions hold great importance to me in the 
  613. development of these programs! Keep those ideas 
  614. coming!
  615.  
  616.              Anthony Watson
  617.